/*
 * Copyright 2011 The Rusted Roof, LLC.
 *
 *    Licensed under the Apache License, Version 2.0 (the "License");
 *    you may not use this file except in compliance with the License.
 *    You may obtain a copy of the License at
 *
 *        http://www.apache.org/licenses/LICENSE-2.0
 *
 *    Unless required by applicable law or agreed to in writing, software
 *    distributed under the License is distributed on an "AS IS" BASIS,
 *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *    See the License for the specific language governing permissions and
 *    limitations under the License.
 */

package org.proteusframework.core.api.model;

import java.util.Properties;

/**
 * Identifies that an {@link IObject} provides rudimentary key-value metadata support.
 *
 * @author Tacoma Four
 */
public interface IMetadata
{
    /**
     * Set of properties that provides additional metadata describing the object. For example,
     * an author, support email address, copyright, instructions, caveats, etc. could all be contained here.
     *
     * @return Non-null set of properties
     */
    Properties getMetadata();
}
